Method, system, program, and data structure for cleaning a database table using a look-up table

ABSTRACT

Disclosed is a method, system, program, and data structure for performing a clean operation on an input table. An input data table name indicates the input table. A first column in a table including a plurality of entries and at least one rule definition are processed. Each rule definition indicates a look-up column including a plurality of entries and a clean operation. A determination is made, for each record in the input table column, whether the record matches one entry in the look-up column. If so, the clean operation indicated in the rule definition is performed on each record that matches one entry in the look-up column.

CROSS-REFERENCE TO RELATED APPLICATIONS

This application is related to the following co-pending and commonly-assigned patent applications, all of which are filed on the same date herewith, and which are incorporated herein by reference in their entirety:

-   “Method, System, Program, And Data Structure for Transforming     Database Tables,” to Mark A. Cesare, Tom R. Christopher, Julie A.     Jerves, Richard H. Mandel III, and having U.S. application Ser. No.     09/400,507; -   “Method, System, Program, And Data Structure for Pivoting Columns in     a Database Table,” to Mark A. Cesare, Julie A. Jerves, and     Richard H. Mandel III, and having U.S. application Ser. No.     09/400,057; -   “Method, System, Program, and Data Structure for Cleaning a Database     Table,” to Mark A. Cesare, Tom R. Christopher, Julie A. Jerves,     Richard H. Mandel III, and having U.S. application Ser. No.     09/399,694; and -   “Method, System, and Program for Inverting Columns in a Database     Table,” to Mark A. Cesare, Julie A. Jerves, and Richard H. Mandel     III, and having U.S. application Ser. No. 09/400,690.

BACKGROUND OF THE INVENTION

1. Field of the Invention

The present invention relates to a method, system, program, and data structure for cleaning a database table and, in particular, for using a look-up table when performing the clean operations.

2. Description of the Related Art

Data records in a computer database are maintained in tables, which are a collection of rows all having the same columns. Each column maintains information on a particular type of data for the data records which comprise the rows. A data warehouse is a large scale database including millions or billions of records defining business or other types of transactions or activities. Data warehouses contain a wide variety of data that present a coherent picture of business or organizational conditions over time. Various data analysis and mining tools are provided with the data warehouse to allow users to effectively analyze, manage and access large-scale databases to support management decision making. Data mining is the process of extracting valid and previously unknown information from large databases and using it to make crucial business decisions. In many real-world domains such as marketing analysis, financial analysis, fraud detection, etc, information extraction requires the cooperative use of several data mining operations and techniques.

Once the desired database tables have been selected and the data to be mined has been identified, transformations on the data may be necessary. Transformations vary from conversions of one type of data to another, e.g., converting nominal values into numeric ones so that they can be processed by a neural network, to definition of new attributes, i.e., derived attributes. New attributes are defined either by applying mathematical or logical operators on the values of one or more database attributes. The transformed data is stored in a target database where it may then be mined using one or more techniques to extract the desired type of information necessary to make the organizational decisions. Further details of data mining are described in the International Business Machines Corporation (IBM) publication entitled “White Paper: Data Mining Solutions” (IBM Copyright, 1996)

Data transformation refers to the process of filtering, merging, decoding, and translating source data to create validated data for the data warehouse and data mining tools. For example, a numeric regional code might be replaced with the name of the region. Data transformations and cleansing are used when data is inconsistent or incompatible between sources. In such case, some level of data cleansing is needed to ensure data consistency and accuracy. Some of the current techniques for transforming and cleansing data include the use of an SQL WHERE clause to limit the rows extracted from the source table. Further, formulas and expressions specified in the column definition window and constants and tokens are used to eliminate and modify data.

Previous versions of IBM Visual Warehouse included programs to allow users to perform numerous functions on the source data. For instance, if one database table has revenue data in U.S. dollars and another data table stores revenue data in foreign currency denominations, then the foreign revenue data must be cleansed before both sets of data can be analyzed together. Transformation operations may be performed using application programs external to the database program that process and transform tables of data records. Further details of data warehousing and data transforms, are described in the IBM publications “Managing Visual Warehouse, Version 3.1,” IBM document no. GC26-8822-01 (IBM Copyright, January, 1998), which is incorporated herein by reference in its entirety.

Notwithstanding current programs for cleansing data, there is a need in the art to provide users greater control over operations to clean input data.

SUMMARY OF THE PREFERRED EMBODIMENTS

To overcome the limitations in the prior art described above, preferred embodiments disclose a method, system, program, and data structure for performing a clean operation on an input table. An input data table name indicates the input table. A first column in a table including a plurality of entries and at least one rule definition are processed. Each rule definition indicates a look-up column including a plurality of entries and a clean operation. A determination is made, for each record in the input table column, whether the record matches one entry in the look-up column. If so, the clean operation indicated in the rule definition is performed on each record that matches one entry in the look-up column.

In further embodiments, information on each record that does not match one entry in the look-up column is written into a log record.

In still further embodiments, one rule definition further includes a find criteria and a replacement value. In such case, performing the clean operation involves determining whether each record that matches one entry in the look-up table matches the find criteria and inserting the replacement value into each record in the input data column that matches the find criteria. Subsequent applications of additional rule definitions applied to the same record operate on replacement values inserted in the record in previously applied rule definitions.

Preferred embodiments provide a data command structure including one or more rule definitions for performing different operations on the data in an input data table. Preferred embodiments further provide a look-up table that is applied to an input column in the table to confirm whether the data in the input column is valid, i.e., matches one of the entries in the look-up table. If the data is not valid according to the look-up table column, then an indication is made in a log table to allow further action to be taken to correct the invalid data in the input table column. After the data in the input table column is validated, then clean operations may be performed on the valid data.

Preferred embodiments further provide a command structure that accommodates multiple types of clean operations to be performed on an input data table before the input data table is written to the output table. Further, preferred embodiments allow a client to transfer clean commands to the database server including the database for execution on the database server. This reduces network traffic as the database tables and rule definitions subject to the clean operation do not have to be transferred between the database server and the client constructing the clean commands.

BRIEF DESCRIPTION OF THE DRAWINGS

Referring now to the drawings in which like reference numbers represent corresponding parts throughout:

FIG. 1 illustrates a computing environment in which preferred embodiments are implemented;

FIG. 2 illustrates the parameters used in a transform command to clean input tables in accordance with preferred embodiments of the present invention;

FIGS. 3 a, 3 b, 4, 5, and 6 illustrate examples of a rule table to clean data in accordance with preferred embodiments of the present invention;

FIGS. 7, 8 a, 8 b, 8 c, 8 d, and 8 e illustrate logic to clean an input data table using a look-up table in accordance with preferred embodiments of the present invention;

FIG. 9 illustrates an example of an input data table; and

FIGS. 10 a, 10 b, 10 c, and 10 d illustrate examples of rule table to apply to clean columns in the input data table in FIG. 9 in accordance with preferred embodiments of the present invention.

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENTS

In the following description, reference is made to the accompanying drawings which form a part hereof and which illustrate several embodiments of the present invention. It is understood that other embodiments may be utilized and structural and operational changes may be made without departing from the scope of the present invention.

Computing Environment

FIG. 1 illustrates a computing environment 2 in which preferred embodiments are implemented. The environment 2 includes a server 4 and client 6. The server 4 and client 6 would include an operating system, such as MICROSOFT WINDOWS 98 and WINDOWS NT, AIX, OS/390, OS/2, OS/400, SUN SOLARIS,** and may be comprised of any suitable server and client architecture known in the art. The server 4 and client 6 include a database program 8 a and 8 b, wherein 8 a comprises the server 4 side of the database program and 8 b comprises the client 6 side. The server 4 and client 6 may communicate via any communication means known in the art, such as a telephone line, dedicated cable or network line, etc, using any protocol known in the art including TCP/IP network (e.g., an Intranet, the Internet), LAN, Ethernet, WAN, System Area Network (SAN), Token Ring, etc. Alternatively, there may be separate and different networks between the servers 4 and client 6.

**Microsoft, Windows, Windows NT are registered trademarks and Microsoft SQL Server is a trademark of Microsoft Corporation; DB2, AIX, OS/390, OS/400, and OS/2 are registered trademarks of IBM; and Oracle8 is a trademark of Oracle Corporation; and Solaris is a trademark of Sun Microsystem, Inc.

The client/server database programs 8 a, b, may be comprised of any client/server database program known in the art, such as DB2, Oracle Corporation's ORACLE 8, Microsoft SQL Server, ** etc. The database programs 8 a and 8 b are used to access operations and perform operations with respect to information maintained in one or more databases 10. The database(s) 10 would consist of multiple tables having rows and columns of data, e.g., tables 14 and 18. The database program 8 a further includes at least one rule table 20, look-up table 22, and log table 24 used during the execution of the clean transform. Further details of the architecture and operation of a database program are described in the IBM publications “DB2 for OS/390: Administration Guide, Version 5” IBM document no. SC26-8957-01 (Copyright IBM. Corp., June, 1997) and “A Complete Guide to DB2 Universal Database,” by Don Chamberlin (1998), which publications are incorporated herein by reference in its entirety.

**Microsoft, Windows, Windows NT are registered trademarks and Microsoft SQL Server is a trademark of Microsoft Corporation; DB2, AIX, OS/390, OS/400, and OS/2 are registered trademarks of IBM; and Oracle8 is a trademark of Oracle Corporation; and Solaris is a trademark of Sun Microsystem, Inc.

In preferred embodiments, the clean transform program is implemented using the IBM stored procedure database program structure. A stored procedure is a block of procedural constructs and embedded SQL statements, i.e., an application program, that is stored in a database and can be called by name. Stored procedures allow an application program to execute in two parts. One part runs on the client and the other on the server. This allows one client call to produce several accesses of the database from the application program executing on the system, i.e., server including the database. Stored procedures are particularly useful to process a large number of database records, e.g., millions to billions of records, without having to transfer data between the server 4 and client 6. The client stored procedure passes input information to the server stored procedure which then, executing within the database program 8 including the database 10, processes numerous database records according to such client input information. The server stored procedure program is initiated by the client, and during execution the client cannot communicate with the stored procedure executing in the server. Further details of stored procedures are described in the publication “A Complete Guide to DB2 Universal Database,” “A Complete Guide to DB2 Universal Database,” which was incorporated by reference above.

The clean transform of the preferred embodiments is implemented as a stored procedure application program 12 in the server 4. The clean transform stored procedure 12 receives as input a name of an input table 14, a name of a rule table 20, name of a look-up table 22, and transform rules 16 from the client 6 specifying the clean operations to perform on the data in the input table 14. The results of the clean operations performed by the clean transform stored procedure 12 in response to the transform rules 16 are generated into the output table 18. Alternatively, the transformed, i.e., cleaned input table is written to the database 10 to overwrite the previous version of the input table.

The client side of the clean transform stored procedure 20 generates the transform rules 16 that specify the clean operations to perform and initiate execution of the clean transform stored procedure 12. The rules specified by the client side 20 are capable of implementing the following clean operations at the server 4: replace values in selected data columns that are missing, nonvalid, or inconsistent with appropriate substitute values; remove unsuitable data rows; clip numeric values; perform numeric discretization; remove excess white space from text; copy columns from the source table to the target table; in-string substitution; and sub-string substitution. Further, the client generated rules 16 can instruct the clean transform stored procedure 12 to ignore case and white spaces when locating strings and permit a tolerance value for numeric data.

In preferred embodiments, the client side 8 b can pass parameters to the clean transform stored procedure as “host variables” or embedded in a CALL statement. In either case, the parameters or transform rules 16 must be specified to control the operation of the clean transform 12.

Structure and Operation of the Clean Transform Rules

A graphical user interface (GUI) at the client 6 may be used to enter various input parameters to control a clean operation. In response to such user input, the client side 20 would generate an application program interface (API) call to the clean transform stored procedure 12 including the parameters shown in FIG. 2 to initiate and control the operation of the clean transform stored procedure 12. The clean parameter field 50 shown in FIG. 2 includes an input table name 52, output table name 54, log table name 56, run ID 58, and replacement rule definition(s) 60.

The input table name 52 specifies the input table 14 table including the data subject to the clean operations and the output table name 54, which is optional, specifies the output table 18 where the cleaned data from the input table 14 is placed. The log table name 56 indicates the name of a log file into which warnings and exceptions that occur during execution of the clean transform stored procedure 12 are stored. The run ID 58 appears in the log file and is used to identify the clean transform operations for which the log entry was made. The replacement rule definition(s) 60 identifies an input column from the input table 14 and an output column in the output table 18, and one or more rules to use when processing the input columns. The specified field of parameters 50 defines the transform rules 16 the client side of the clean transform stored procedure 20 presents to the clean transform stored procedure 12 in the server 4.

The replacement rule definitions 60 parameter comprises one or more definitions, such that each definition 80 includes sub-parameters 82-100. Thus, the rule definitions parameter 60 may specify multiple distinct rule definitions 80, each describing particular operations to perform on specified columns in the input table. Below is a description of the sub-parameters included in each definition 80 a user may specify in the rule definitions parameter 60:

-   -   Input Data Column Name 82: defines an existing column in the         table having the Input Data Table Name 52: that contains the         data to be operated on in accordance with the rules specified in         the rule table and other parameters. This parameter is required         in the definition 80. The input data column must be capable of         being modified, so that the clean transform stored procedure 12         will not update a value which has a constraint, such as for a         unique key column or a referential constraint.     -   Output Data Column Name 84: defines the name of a column in the         table having the Output Data Table Name 54 where cleaned data is         placed. This parameter is optional, and the default is the input         data column name 82. Thus, if no output data column or output         table is specified, clean data is placed back into the copy of         the input table in memory being processed.     -   Rule Table Name 86: Provides the name of the table containing         the “find and replace” rule patterns. This sub-parameter is         optional; if not provided the values for the column are copied         to the output table, and are only modified if the option to         compress or remove white space is specified.     -   Rule Table Sort-Key Column Name 88: When a rule table includes         multiple rules to apply to the input data column, this parameter         88 indicates a sort key-column in the rule table that provides         an ordering in which the rules are applied to rows (fields) in         the input data column.     -   Rule 90: This sub-parameter is required if the rule table name         86 is specified. This sub-parameter defines the type of rule         included in the rule table to use when processing the values in         the input data column. Further details of rule 90 are described         below.     -   Rule Table Columns 92: This sub-parameter is specified if the         rule table name is specified. The number of columns depend on         the rules, examples of which are discussed below. If a rule         table has different columns for different rule definitions,         i.e., one rule table stores multiple rule definitions, then the         rule table columns 92 parameter indicates those columns in the         rule table including the specific rules for one rule definition.     -   Row Clean Indicator 94: Boolean YES/NO value. If YES is         specified and there is a match in the input data column to the         “find” condition, then the input value is not copied to the         output table and the located matching rows are deleted from the         temporary input table. Note that the setting this parameter to         YES will affect subsequent attempts to process the transitional         input data columns as the matching entries in the input data         columns subject to the row clean indicator 94 are empty. If the         value for this sub-parameter is NO, the matching entry in the         input data column is copied to the output data column or the         input data column. Further, any replacement value in a rule         table is ignored and need not be specified when the row clean         indicator is used. This sub-parameter is optional, and is         ignored unless a rule table name 86 is specified.     -   Rule Escape Character 96: Certain characters have special         meaning, such as the percent sign (%), which represents any         string of zero or more characters, or the underscore character         (_), which represents a single character. The use of the rule         escape character in the search string followed by the special         character, means that the query looks for the actual special         character following the escape character, and ignores the         special meaning.     -   White Space Indicator 98: Optional boolean value that indicates         whether white spaces are ignored when searching     -   Numeric Tolerance 100: Specifies a tolerance value when doing a         “find” operation with respect to numeric values. Thus, numbers         within the “tolerance” range of the searched upon number will         produce a match.     -   Look-up Table Name 102: The name of the table 22 containing the         look-up data patterns.     -   Log Table Name 104: The name of the table including the records         that did not match any value in the specified columns of the         look-up table 22. If this name 104 is not specified, then         records that do not match the look-up table 22 values will not         be recorded.     -   Look-Up Table Sort-Key Column Name 106: The name of a column in         the look-up table 22 used as a sort key to sort the rows in the         look-up table 22.     -   Look-Up Table Columns 108: Name of columns in look-up table 22.         In preferred embodiments there is a look-up table column to         apply for each rule definition in the rules that is applied.     -   Do Not Match instructions 110: defines action to take if no row         in the specified look-up table column matches the input data         record. If a log table name is specified in 104, then the record         that does not match is written to the log table 24. The         instructions may specify one of the following actions to take         when writing the record from the input table 14 that did not         match to the output table 18: (1) write the same value as the         input data; (2) write a database NULL; (3) write a blank         field; (4) omit entire row from output table 18 even if other         columns in row match specified look-up table 22 column; (5) a         user specified string.     -   Look-Up Escape Character 112: indicates a special character that         should be treated as a literal character in the look-up table         22.     -   Respect Case Indicator 114: indicates whether characters in the         look-up table are case sensitive.

When cleaning a column in the input table 14, a determination is made as to whether each record in the specified input table column matches an entry in the specified look-up table 22 column. If there is a match, then those matching records are cleaned according to rules specified in the parameter or the rule table 20. Those records in the input table 14 column that do not match a row in the specified look-up table 22 column are written to the log table 24. The do not match instructions 110 indicate what to write to the output table for those records that do not match the look-up table 22 column.

For each record in the input table column that did not match an entry in the specified look-up table column, the clean transform 12 would write to the log table 24 the name of the input table, the input table column name, and the row number including the non-matching record; the output table name; first date the clean transform 12 wrote to the log table 24; the data type of the data in the input table column; the record in the input table column that did not match any entry in the specified look-up table column; and the time stamp when the non-matching row was written to the input table.

The rule parameter 90 may specify the clean operation to perform. Alternatively, the rule indicating the clean operation to perform may be specified in the rule table 20 that includes columns of different rule definitions. The rule table may include one find column used in two rule definitions and different columns for the replacement values for the two rule definitions having the same find value. Thus, both rule definitions search on the same criteria, but provide different replacement values. Alternatively, the rule table may have different columns for the find criteria for two rule definitions, but the same replacement value for the different columns including the find criteria. Still further, the rule table may include multiple search criteria for a single rule definition and a corresponding search value for each of the search criteria. In this way, multiple search criteria could be applied to the same input column as part of one rule definition. Upon finding the first find value matching the field content, the replacement value corresponding to that matching find value would be inserted into the matching field.

Moreover, multiple rules in different columns of the same rule table or in different rule tables may sequentially operate against the same input data column. If more then one set of rules is to be applied to an input data column, a definition 80 must be specified for each rule. The order of the definitions listed in the replacement rule definitions 60 parameter indicates the order in which the rules are applied to the input data column. In this way, values in the input data column may be modified in sequence and processed according to clean operations specified in different rule definitions. In preferred embodiments, the processing of subsequent rule definitions on the same column will depend on any replacement values inserted in the field during the application of a previous rule definition, not the original content in the input data column. Thus, rule definitions are applied to the copy of the input data table in memory as it is being processed. The find operation with respect to a field will apply to any previously inserted replacement value inserted into the field. If this inserted replacement value matches the search criteria of the subsequent rule definition, then another replacement value will be inserted into the field.

The rule sub-parameter 90 indicates the type of rule indicated in the table identified in the rule table name sub-parameter 86. Possible values for rule type could include find and replace, discretize, numeric clip or any other find and replace type operations known in the art. A find and replace locates a field in the input data column matching the find value. This find value is specified in one column of the rule table. The column including the find rule is provided in the first rule table column identified in sub-parameter 92. This rule table column would further identify a second column in the rule table including a replacement value. If the find operation produces a match on the find value, then the replacement value is inserted in the field having the content matching the find value. The specification of the value to find in the rule table column must match the type of data in the input data column, e.g., only numbers are allowed in numeric “find” columns, pattern strings are allowed for character columns. Further for either numeric or character data, the database null value can be used as a find or replacement value.

FIGS. 3 a and 3 b illustrate a possible format for rule tables for a find and replacement rule type. FIG. 3 a illustrates a two column find and replace rule table for an input data column including character values. The find pattern is what is searched for in the input data column and the replacement text value is what is inserted into the field matching the find pattern. FIG. 3 b illustrates a similar two column find and replace rule table for an input column having numerical values.

If the rule 90 indicates a discretization type, then there is both an upper and lower bound for the find value. The find operation can specify to search for matching values in the input data column that are between the upper and lower bounds, outside of the upper and lower bounds, less than the lower bound, or greater than the upper bounds. Another column in the rule table would specify a replacement operation to perform. If the upper and lower boundaries specified character strings, then SQL rules would be used to determine whether strings in the input data column satisfy the search criteria. FIG. 4 illustrates a table format for discretization for character and numeric data types. The replacement value is inserted into every field in the input data column having a value between the upper and lower bounds. Placement of the NULL indicator in the upper or lower bounds can affect whether the find seeks all fields in the input data column greater or less than one of the bounds. The discussion below with respect to FIGS. 6 b and 6 c explains how a NULL value in one of the find values affects the search criteria.

If the rule 90 indicates a numeric clip type, then the find operation finds fields in the input data column that are less than, equal to or greater than specified values. FIG. 5 shows that discretization includes an upper and lower values for both the find and replace. Any values in the input data column less than the lower bound and greater than the upper bound are replaced with the lower and upper replacement value, respectively. As with discretization, the use of the NULL value in one of the find values can affect the find operation, as discussed below with respect to FIGS. 6 d and 6 e.

For find and replacement, discretization, and numeric clip rule types, the database NULL value can be used as the find or replacement value. The NULL value indicates the absence of information. The database NULL value is only allowed for a pattern find value or replacement value if the database input column allows for NULL values, i.e., the input data column was not defined with a NOT NULL clause. The database NULL value may also be used to determine how to consider lower and upper bound values in the discretization and numeric clip operations, as described below.

FIG. 5 shows that discretization includes an upper and lower values for both the find and replace. Any values in the input data column less than the lower bound and greater than the upper bound are replaced with the lower and upper replacement value, respectively. As with discretization, the use of the NULL value in one of the find values can affect the find operation, as discussed below with respect to FIGS. 8 d and 8 e.

If the rule 90 indicates in-string substitution, then the find operation finds fields in the input data column that match the find pattern and replaces it with the replacement value. FIG. 6 illustrates a two column in-string and sub-string substitution rule table for an input data column including character values. The find pattern is what is searched for in the input data column and the replacement value is what is inserted into the field matching the find pattern. If the rule 90 is sub-string substitution, then the sub-string located in the input data column that matches the find pattern is replaced with the replacement value.

FIG. 7 illustrates logic implemented in the clean transform stored procedure 12 (clean transform 12) to determine if each record the input data column, specified in parameter 82, matches one record in the look-up table 22 column specified in parameter 108. The matching operation with respect to the look-up table 22 is used to determine that the values in the input table column are one of a permitted value or otherwise valid. For instance, if the input table column included United States postal zip codes, then the look-up table 22 column to apply could include every possible zip code in the United States. If a zip code entry in the input table 14 column did not match one of the permissible United States zip codes specified in the look-up table column, then the record in the input table is invalid.

With respect to FIG. 7, control begins at block 120 with the clean transform 12 receiving the clean parameters 50 and a set of sub-parameters 80 for each rule definition in an API function call. The clean transform 12 accesses (at block 122) the input table 14 from the database 10 indicated in the input data table name 52. For each rule definition 80 specified in the replacement rule definitions 60 parameter, the clean transform 12 executes a loop to perform the remaining operations in FIG. 7 and operations in FIGS. 8 a, b, c, d, e.

In processing each rule definition, the clean transform 12 accesses (at block 126) the input data column from the input table 14 indicated in the input data column name 82 parameter for the rule definition and the look up-table column indicated in the look-up table name 104 and column 108 in the sub-parameters 80 for the rule definition. The clean transform begins a loop at block 132 to determine whether each record i in the input data column matches one of the entries in the accessed look-up table 22 column. If record i does not match one entry in the look-up table column (at block 134), then the clean transform 12 processes (at block 136) the instructions in the do not match instructions parameter 110 to determine the action to take with respect to the record in the output table corresponding to the non-matching record in the accessed input table. This action may comprise writing to the output table the input data, a NULL value, a blank row or some other action. The clean transform 12 then writes (at block 138) the non-matching record and related information to the log table 24.

If record i in the input data column does match an entry in the accessed look-up table column, then the clean transform proceeds to block 200 in FIG. 8 a to perform the clean operation on record i. Thus, in the preferred implementation the clean operation is interleaved with the look-up checking. In alternative embodiments, the clean transform 12 may perform all the look-up checking to the input data column, and then perform the clean operations on those records in the input data column that matched a record in the accessed look-up table column.

FIGS. 8 a, b, c, d, and e illustrate logic implemented in the clean transform 12 to clean the records i in the input data column that match one record in the look-up table according to the sub-parameters 80 for the current rule definition being processed. As discussed, a user at the client 6 would specify certain clean operations to perform and the client side of the clean transform 20 would generate an API function call including the clean parameters 50 and definitions 80 from information the user entered in the GUI. With respect to FIG. 8 a, control begins with the clean transform 12 accessing (at block 200) the rule table from the rule table name parameter 86 and input columns in the rule table indicated in the rule table columns parameter 92 for the rule definition. The clean transform 12 determines (at block 210) whether the rule table sort-key column name is non-empty. If so, the clean transform 12 sorts (at block 210) the rules in the rule columns for the rule definition according to the order specified in the sort-key column in the rule table. As discussed, a sort-key column may be provided if a rule table includes multiple rules to apply for the rule definition. Otherwise, if the sort key-column parameter 88 is empty, the rule columns are sorted in ascending order. After block 212 or the yes branch of block 210, the clean transform 12 determines (at block 214) whether the rule parameter 90 indicates a find and replace clean operation.

If the clean operation for the current definition is a find and replace, the clean transform 12 determines (at block 216) one or more find values or patterns (if the data type is a character) from the first column in the rule table indicated in the rule table columns parameter 92. The clean transform 12 inserts (at block 218) the replacement value/pattern in the column in the rule table having the same column number as the second column in the rule table columns 92 sub-parameter if one of the find values or patterns matches the field content. Note that if there are multiple find values/patterns in the rule table, then there is a different corresponding replacement value for each separate find/value pattern. The replacement value corresponding to the first matching find value is inserted in the field. The clean transform then returns (at block 220) to block 124 to process the next rule definition 80 in the rule definition parameters 60.

During the find and replace searching, and the searching operations for the discretization and numeric clip rule types, other sub-parameters are considered. If a rule escape character is indicated in sub-parameter 96, the clean transform 12 searches for a character matching the character following the escape character, which may be a character that usually has specific search meaning, such as a percent (%), underscore (_), comma (,) or semicolon (;). Further, if the row clean indicator sub-parameter 94 is set to YES, then any field, i.e., row, in the input data column matching the find value/pattern is not copied to the output table in the current rule definition being applied, or any further rule definitions that may apply to the field or row. If a numeric tolerance sub-parameter 100 is provided, than number fields in the input data column will return a match if the field value is equal to the find value within a range specified by the numeric tolerance. Further, if the ignore white space indicator sub-parameter 98 is YES, then white spaces are removed from the field when determining whether the field matches the find value/parameter; otherwise, white spaces are considered characters.

If the rule indicated in the rule sub-parameter 90 is discretization (at block 240), then the clean transform 12 determines (at block 242) the upper bound, lower bound and replacement values from the accessed rule table. The upper, lower, and replacement columns in the rule table are indicated in the first, second, and third columns in the rule table columns sub-parameter 92, respectively. The clean transform 12 determines (at block 244) whether the upper and lower bounds are both NULL. If so, the clean transform 12 does the replacement (at block 246) in every field in the current input data column. Otherwise, the clean transform 12 begins a loop at block 248 to consider each rule in the rule table, when there are multiple rules to apply to the matching record i. For each rule, the clean transform 12 determines (at block 250) whether the accessed field in the input data column is NULL. If so, the clean transform 12 determines (at block 252) whether either the upper or lower bounds are NULL. If so, the clean transform 12 inserts (at block 254) the replacement value in the rule table into the field; otherwise, no replacement value is inserted (at block 256). From blocks 254 or 256, control transfers to block 258 where the clean transform 12 performs another iteration of the loop beginning at block 248 for the next field (row) in the input data column.

If the field in the input data columns is not NULL (from the NO branch at block 250), then the clean transform 12 determines (at block 260) whether both the upper and lower bounds are NULL. If so, the clean transform 12 inserts the replacement value into the field and proceeds to block 258 to consider any further rows in the input data column. Otherwise, the clean transform 12 determines (at block 264) whether only the upper bound is NULL. If so, the clean transform 12 inserts (at block 266) the replacement value into the current field if the field in the input data column is greater than the lower bound minus the numeric tolerance for numeric data types where a numeric tolerance is specified. If no numeric tolerance is provided in parameter 100 or the input column is a character type, then there is no consideration of numeric tolerance when performing the find operation. If only the lower bound is NULL (at block 268), then the clean transform 12 inserts (at block 270) the replacement value into the current field if the field in the input data column is less than the upper bound plus any numeric tolerance for numeric data types where a numeric tolerance is specified. If neither the upper nor lower bound are NULL, then the clean transform 12 inserts (at block 272) the replacement value in the field if the field value is less than or equal to the upper bound plus any provided numeric tolerance AND less than or equal to the lower bound minus any provided numeric tolerance. After applying one rule in the rule table at blocks 254, 256, 262, 266, 270 or 272, the clean operation 12 then considers (at block 274) any further rules for the current record i in the input data table by proceeding back to block 248. After finding a match or considering all rules in the rule table for a given field, the clean transform proceeds (at block 258) to consider the record i in the input data column by proceeding back to block 132.

After all records i in the input data column are considered from blocks 132 to 258, the clean transform proceeds (at block 276) to block 124 to execute the next rule definition against a specified input data column.

If the rule indicated in the rule parameter 90 is a numeric clip (at block 300 in FIG. 8 d), then the clean transform 12 determines (at block 302) the upper bound, lower bound, and replacement value in the columns of the rule table indicated in the rule table columns parameter 92. The clean transform then determines (at block 302) whether both upper and lower bounds are NULL. If so, the clean transform 12 skips (at block 304) the input data column, and inserts no replacement values into any row. Otherwise, the clean transform 12 begins a loop at block 306 to consider each rule in the rule table, if there are multiple rules, against the current record i. The clean transform 12 determines (at block 308) whether the field content is NULL. If so, the clean transform 12 does not insert (at block 310) the replacement value for any into the field and proceeds (at block 312) to consider the next row in the column until all rows are processed. If only the upper bound is null (at block 314), then the clean transform 12 inserts the lower replacement value in the field (at block 316) if the field value is less than the lower bound minus any numeric tolerance indicated in sub-parameter 100. If only the lower bound is NULL (at block 318), then the clean transform 12 inserts the upper replacement value in the field (at block 320) if the field value is greater than the upper bound plus any numeric tolerance. If neither the lower nor upper bound are NULL, then the clean transform 12 inserts (at block 322) the lower replacement value if the field is less than or equal to the lower bound minus any numeric tolerance OR inserts the upper replacement value if the field is greater than or equal to the upper bound plus any tolerance. After applying one rule against one field at blocks 310, 316, 320 or 322, the clean transform 12 then proceeds (at block 323) back to block 306 to consider the next rule in the rule table, if there are further rules to apply to the record i. After applying all rules in a rule table to the record i, the clean transform 12 proceeds (at block 312) back to block 132 to consider the next record i in the input data column.

After processing all rules in the rule table and matching records i in the input data column from block 312 or block 324, the clean transform 12 proceeds (at block 324) to block 124 to consider any further rule definitions in the replacement rule definition parameter 60. After the last rule definition 80 in the replacement rule definitions parameter 60 is processed at blocks 220, 274 or 324, then the clean transform 12 then determines (at block 326) whether the output data table name 54 specifies an output data table 18 in the database 10 to receive any cleaned or modified input data columns. If so, then the clean transform 12 writes (at block 328) the input data columns, including replaced and cleaned fields, to the specified output data table 19. Otherwise, the modified and processed input data columns are written (at block 330) to the input table 14.

Preferred embodiments provide a command data structure to control a stored procedure program to first check whether a record matches a value in a look-up table and then clean the record if it matches. In this way, the look-up table is used to validate the data in the input records. The rules to clean the tables may be provided in a rule table data structure that provides one or more clean rules for different columns and in different sequences. This allows a single instance of execution of the clean program to perform numerous types of operations on the columns in the input table. Preferred embodiments thus provide a flexible and programmable data structure and program to provide fine grained control of clean operations. Further, with preferred embodiments, the client 6 does not increase network traffic because the client does not transfer the tables to clean between the database server 4. Instead, the client 6 merely provides a command data structure including various parameters and rules to a stored procedure 12 that executes in the server 4 to perform the clean operations within the database program 8 on the server 4. Such savings in network traffic can be significant when very large database tables, including millions or billions, of records are cleaned.

FIGS. 9 and 10 a, b, c, d illustrate an example of how rule tables may be applied to clean an input data table. FIG. 9 illustrates an input data table to be cleaned including columns concerning sales information: city, indicating the sale location; product name; product category; dollar sales; and unit sales. FIGS. 10 a, b, c, and d illustrate different rule tables to apply to columns in the input table in FIG. 9. FIG. 10 a illustrates a find and replace rule to locate certain strings in the City column that begin and end with “%”. The first percent in the find value represents any string of zero or more characters. An escape character of “/” is indicated in parameter 96 so the search criteria includes strings that start and end with the percent sign (%). The replace value is on the right. Thus, FIG. 10 a illustrates a rule table including multiple rules having search criteria to apply against each field in a column, e.g., the CITY column, of the input data table. FIG. 10 a would remove the abbreviations in the CITY input data column and replace them with a complete city name for the replacement value corresponding to the find value matching the field in the City column.

FIG. 10 b provides a numeric clip rule table. In the Unit Sales column, values less than 100 are considered invalid and will be rounded up to 100, and any sales number greater than 15,000 is considered NULL. Later, the rule table in FIG. 8 d will be used to flag rows with a NULL value to avoid in calculations. Thus, the rule table in FIG. 8 b processes each field in the Unit Sales data column and replaces values less than 100 with 100 and replaces values greater than 15,000 with NULL. A numeric tolerance may be specified to apply the rule to values “close enough” to the lower or upper bound.

FIG. 10 c is a discretization rule table used to replace the code values in the Product Category column of the table in FIG. 9 with meaningful descriptive terms. Code values within certain string ranges are a particular type of product. For instance, a Category code in the range from “HA” to “JZ” is a hardware product. The application of the rule table in FIG. 10 c determines which rule has a lower and upper bound that includes the Product Category field and applies the corresponding Replace Value for the rule having the matching find bounds. The Upper Bound in the last row of the rule table in FIG. 10 c includes a NULL value. This means the replacement value is inserted in any field in the Product Category column having a string value greater than “RX.” FIG. 10 c further provides a sort column, which would be included in the sort-key column name parameter 88, indicating the order in which to sort the rows in the rule table before applying the rule table to the input column

FIG. 10 d is a find and replace table used to clean up the already processed data in the input table in FIG. 9. A rule definition including the rule table in FIG. 10 d and having the row clean indicator parameter 94 set to YES would eliminate from further processing and from the final revised table any row in the input table (FIG. 9) having a product name of NULL. If the compress white space indicator is set in the parameters with the rule definition including FIG. 10 d applied to the Product Name column, then any white space will be removed from the product name, such as the spaces between “Pick Axe” in the first data row of the input table in FIG. 9.

Conclusion

This concludes the description of the preferred embodiments of the invention. The following describes some alternative embodiments for accomplishing the present invention.

The preferred embodiments may be implemented as a method, apparatus or article of manufacture using standard programming and/or engineering techniques to produce software, firmware, hardware, or any combination thereof. The term “article of manufacture” (or alternatively, “computer program product”) as used herein is intended to encompass one or more computer programs and data files accessible from one or more computer-readable devices, carriers, or media, such as a magnetic storage media, “floppy disk,” CD-ROM, a file server providing access to the programs via a network transmission line, holographic unit, etc. Of course, those skilled in the art will recognize that many modifications may be made to this configuration without departing from the scope of the present invention.

Preferred embodiments were described with respect to specific data structures, such as a rule table having columns of rules, and an arrangement of parameters to provide a vehicle for transferring commands to the clean transform stored procedure program. However, those skilled in the art will recognize that modifications may be made to the architecture of the data structures used to convey multiple clean rules and still remain within the scope of the present invention.

Preferred embodiments were described with respect to three rule types, find and replace, discretization, and numeric clip. In further embodiments, other types of rules may be provided and included in the command data structure of the preferred embodiments to perform different types of clean operations known in the art.

In preferred embodiments, the clean transform program was executed in a stored procedure type program, such as that used in the IBM DB2 database system. However, in further embodiments, different types of application programs, other than stored procedure programs, may be executed in the server 4 or even the client 6 to perform clean operations in accordance with the command data structures of the preferred embodiments.

In preferred embodiments, the input table and output table were included in a database in the server in which the clean transform program is executing. In alternative embodiments, the rule, input, and output tables may be distributed at different storage locations at different network devices.

In preferred embodiments, a client constructed the clean operation command and communicated such commands to the database server. In alternative embodiments, the clean operation command of the preferred embodiments may be executed on the machine used to construct the command.

In summary, preferred embodiments disclose a method, system, program, and data structure for performing a clean operation on an input table. An input data table name indicates the input table. A first column in a table including a plurality of entries and at least one rule definition are processed. Each rule definition indicates a look-up column including a plurality of entries and a clean operation. A determination is made, for each record in the input table column, whether the record matches one entry in the look-up column. If so, the clean operation indicated in the rule definition is performed on each record that matches one entry in the look-up column.

The foregoing description of the preferred embodiments of the invention has been presented for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise form disclosed. Many modifications and variations are possible in light of the above teaching. It is intended that the scope of the invention be limited not by this detailed description, but rather by the claims appended hereto. The above specification, examples and data provide a complete description of the manufacture and use of the composition of the invention. Since many embodiments of the invention can be made without departing from the spirit and scope of the invention, the invention resides in the claims hereinafter appended. 

1. A method for performing a clean operation on an input table having an input data table name and at least one input table column including a plurality of records, comprising: receiving at least one rule definition, wherein the at least one rule definition indicates a look-up column including a plurality of entries and a clean operation, wherein the at least one rule definition is associated with at least one rule table column including a find criteria and replacement value; for each record in the input table column, determining whether the record matches one entry in the at least one look-up column; and performing the clean operation indicated in the rule definition on each record that matches one entry in the at least one look-up column by processing the rule table column for the at least one rule definition, wherein the rule table columns include the find criteria and replacement value for the rule definition.
 2. The method of claim 1, further comprising writing information on each record that does not match one entry in the look-up column into a log record.
 3. The method of claim 2, further comprising writing each record that does not match one entry in the look-up column to the log record.
 4. The method of claim 1, wherein each clean operation indicates a match condition and replacement operation, and wherein the clean operation performs the replacement operation on the record if the record satisfies the match condition.
 5. The method of claim 1, wherein the input table is included in a database oil a server, wherein the rule definition is received from a client-side stored procedure program, and wherein a server-side stored procedure executing in the server receives the rule definition from the client-side stored procedure, determines whether the records in the input table match one entry in the look-up column, and performs the clean operation on the database in the server.
 6. The method of claim 1, wherein the rule definition further indicates a rule table including a plurality of different clean operations and at least one parameter indicating at least one rule from the rule table to apply, wherein the rules in the rule table define clean operations to perform, wherein performing the clean operation comprises applying the at least one rule from the rule table indicated by the parameter to each record that matches one entry in the look-up column.
 7. The method of claim 6, wherein the rule table includes columns of different rule definitions, and wherein the parameter indicates at least one column in the rule table providing the at least one rule to apply to each record.
 8. A method for performing a clean operation on an input table having an input data table name and at least one input table column including a plurality of records, comprising: receiving at least one rule definition, wherein each rule definition indicates a look-up column including a plurality of entries and a clean operation and a find criteria and a replacement value; for each record in the input table column, determining whether the record matches one entry in the look-up column; and performing the clean operation indicated in the rule definition on each record that matches one entry in the look-up column by: (i) determining whether each record that matches one entry in the look-up table matches the find criteria; and (ii) inserting the replacement value into each record in the input data column that matches the find criteria, wherein subsequent applications of additional rule definitions applied to the same record operate on replacement values inserted in the record during previously applied rule definitions.
 9. The method of claim 8, wherein the input data column for a first and second applied rule definitions is the same input data column, wherein the replacement value for the first rule definition is inserted into at least one field in the input data column, and wherein the find criteria of the second rule definition is applied to the replacement value inserted in the input data column.
 10. The method of claim 8, wherein the rule definition comprises a type of rule that is a member of the set of rules consisting of: find and replace, discretization, and numeric clip, wherein at least two rule definitions are comprised of different rule types.
 11. The method of claim 8, wherein the find criteria for at least one rule definition comprises an upper bound and lower bound, wherein searching comprises searching for any fields that have values within the upper and lower bounds.
 12. The method of claim 11, wherein searching comprises searching for any fields that have values outside of one of the upper and lower bounds.
 13. A method for performing a clean operation on an input table having an input data table name and at least one input table column including a plurality of records composing: receiving at least one rule definition, wherein each rule definition indicates a look-up column including a plurality of entries and a clean operation, wherein each rule definition is associated with one rule table including find criteria and replacement value for each record in the input table column, determining whether the record matches one entry in the look-up column; and performing the clean operation indicated in the rule definition on each record that matches one entry in the look-un column processing a rule table column for each rule definition, wherein the columns in the rule table include the find criteria and replacement value for the rule definition.
 14. A system for performing a clean operation on an input table having an input data table name and at least one input table column including a plurality of entries, comprising: means for receiving at least one rule definition, wherein at least one rule definition indicates a look-up column including a plurality of entries and a clean operation, wherein the at least one rule definition is associated with at least one rule table column including a find criteria and replacement value; means for determining, for each record in the input table column, whether the record matches one entry in the look-up column; and means for performing the clean operation indicated in the at least one rule definition on each record that matches one entry in the look-up column by processing the rule table column for the at least one rule definition, wherein the rule table columns include the find criteria and replacement value for the rule definition.
 15. The system of claim 14, further comprising means for writing information on each record that does not match one entry in the look-up column into a log record.
 16. The system of claim 15, further comprising means for writing each record that does not match one entry in the look-up column to the log record.
 17. The system of claim 14, wherein each clean operation indicates a match condition and replacement operation, and wherein the means for performing the clean operation performs the replacement operation on the record if the record satisfies the match condition.
 18. The system of claim 14, further comprising: a server; and a database in the server, wherein the input table is included in the database on a server, wherein the rule definition is received from a client-side stored procedure program, and wherein the means for receiving the rule definition from the client-side stored procedure, determining whether the records in the input table match one entry in the look-up column, and performing the clean operation on the database in the server comprise a server-side stored procedure executing in the server.
 19. The system of claim 14, wherein the rule definition further indicates a rule table including a plurality of different clean operations and at least one parameter indicating at least one rule from the rule table to apply, wherein the rules in the rule table define clean operations to perform, wherein the means for performing the clean operation applies the at least one rule from the rule table indicated by the parameter to each record that matches one entry in the look-up column.
 20. The system of claim 19, wherein the rule table includes columns of different rule definitions, and wherein the parameter indicates at least one column in the rule table providing the at least one rule to apply to each record.
 21. A system for performing a clean operation on an input table having an input data table name and at least one input table column including a plurality of entries, comprising: means for receiving at least one rule definition, wherein each rule definition indicates a look-up column including a plurality of entries and a clean operation, wherein each rule definition is associated with one rule table including find criteria and replacement value means for determining, for each record in the input table column, whether the record matches one entry the look-up column; and means for performing the clean operation indicated in the rule definition on each record that matches one entry in the look-up column processing a rule table column for each rule definition, wherein the columns in the rule table include the find criteria and replacement value for the rule definition.
 22. A system for performing a clean operation on an input table having an input data table name and at least one input table column including a plurality of entries, comprising: means for receiving at least one rule definition, wherein each rule definition indicates a look-up column including a plurality of entries and a clean operation and includes a find criteria and a replacement value; means for determining, for each record in the input table column, whether the record matches one entry in the look-up column; and means for performing the clean operation indicated in the rule definition on each record that matches one entry in the look-up column by: (i) determining whether each record that matches one entry in the look-up table matches the find criteria; and (ii) inserting the replacement value into each record in the input data column that matches the find criteria, wherein subsequent applications of additional rule definitions applied to the same record operate on replacement values inserted in the record during previously applied rule definitions.
 23. The system of claim 22, wherein the input data column for a first and second applied rule definitions is the same input data column, further comprising: means for inserting the replacement value for the first rule definition into at least one field in the input data column; and means for applying the find criteria of the second rule definition to the replacement value inserted in the input data column.
 24. The system of claim 22, wherein the rule definition comprises a type of rule that is a member of the set of rules consisting of: find and replace, discretization, and numeric clip, wherein at least two rule definitions are comprised of different rule types.
 25. The system of claim 22, wherein the find criteria for at least one rule definition comprises an upper bound and lower bound, wherein searching comprises searching for any fields that have values within the upper and lower bounds.
 26. The system of claim 25, wherein searching comprises means for searching for any fields that have values outside of one of the upper and lower bounds.
 27. An article of manufacture for performing a clean operation on an input table in a database having an input data table name and at least one input table column including a plurality of records, the article of manufacture comprising computer usable media including at least one computer program embedded therein that causes the computer to perform: receiving at least one rule definition, wherein the at least one rule definition indicates a look-up column including a plurality of entries and a clean operation, wherein the at least one rule definition is associated with at least one rule table column including a find criteria and replacement value; for each record in the input table column, determining whether the record matches one entry in the look-up column; and performing the clean operation indicated in the rule definition on each record that matches one entry in the look-up column by processing the rule table column for the at least one rule definition, wherein the rule table columns include the find criteria and replacement value for the rule definition.
 28. The article of manufacture of claim 27, further comprising writing information on each record that does not match one entry in the look-up column into a log record.
 29. The article of manufacture of claim 28, further comprising writing each record that does not match one entry in the look-up column to the log record.
 30. The article of manufacture of claim 27, wherein each clean operation indicates a match condition and replacement operation, and wherein the clean operation performs the replacement operation on the record if the record satisfies the match condition.
 31. The article of manufacture of claim 27, wherein the input table is included in a database on a server, wherein the rule definition is received from a client-side stored procedure program, and wherein a server-side stored procedure executing in the server receives the tile definition from the client-side stored procedure, determines whether the records in the input table match one entry in the look-up column, and performs the clean operation on the database in the server.
 32. The article of manufacture of claim 27, wherein the rule definition further indicates a rule table including a plurality of different clean operations and at least one parameter indicating at least one rule from the rule table to apply, wherein the rules in the rule table define clean operations to perform, wherein performing the clean operation comprises applying the at least one rule from the rule table indicated by the parameter to each record that matches one entry in the look-up column.
 33. The article of manufacture of claim 32, wherein the rule table includes columns of differ rule definitions, and wherein the parameter indicates at least one column in the rule table providing the at least one rule to apply to each record.
 34. An article of manufacture for performing a clean operation on an input table in a database having an input data table name and at least one input table column including a plurality of records, the article of manufacture comprising computer usable media including at least one computer program embedded therein that causes the computer to perform: receiving at least one rule definition, wherein each rule definition indicates a look-up column including a plurality of entries and a clean operation and includes a find criteria and a replacement value; for each record in the input table column, determining whether the record matches one entry in the look-up column; and performing the clean operation indicated in the rule definition on each record that matches one entry in the look-up column by: (i) determining whether each record that matches one entry in the look-up table matches the find criteria; and (ii) inserting the replacement value into each record in the input data column that matches the find criteria, wherein subsequent applications of additional rule definitions applied to the same record operate on replacement values inserted in the record during previously applied rule definitions.
 35. The article of manufacture of claim 34, wherein the input data column for a fist and second applied rule definitions is the same input data column, wherein the replacement value for the first rule definition is inserted into at least one field in the input data column, and wherein the find criteria of the second rule definition is applied to the replacement value inserted in the input data column.
 36. The article of manufacture of claim 34, wherein the rule definition comprises a type of rule that is a member of the set of rules consisting of: find and replace, discretization, and numeric clip, wherein at least two rule definitions are comprised of different rule types.
 37. The article of manufacture of claim 34, wherein the find criteria for at least one rule definition comprises an upper bound and lower bound, wherein searching comprises searching for any fields that have values within the upper and lower bounds.
 38. The article of manufacture of claim 37, wherein searching comprises searching for any fields that have values outside of one of the upper and lower bounds.
 39. An article of manufacture for performing a clean operation on input table in a database having an input data table name and at least one input table column including a plurality of records, the article of manufacture comprising computer usable media including at least one computer program embedded therein that causes the computer to perform: receiving at least one rule definition, wherein each rule definition indicates a look-up column including a plurality of entries and a clean operation, wherein each rule definition is associated with one rule table including find criteria and replacement value for each record in the input table column, determining whether the record matches one entry in the look-up column: and performing the clean operation indicated in the rule definition on each record that matches one entry in the look-up column by processing a rule table column for each rule definition, wherein the columns in the rule table include the find criteria and replacement value for the rule definition. 